<?php
/**
 * Ruth Library
 * $Id: Parser.php 2 2008-01-17 02:59:56Z baron314159@yahoo.com $
 *
 * LICENSE
 *
 * Copyright (c) 2007, Chris Utz
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Impact Lab nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CHRIS UTZ ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CHRIS UTZ BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */

/**
 * @see Ruth_Annotation_Exception
 */
require_once 'Ruth/Annotation/Exception.php';

/**
 * The main class of Ruth library
 *
 * @category   Ruth
 * @package    Ruth_Channel
 * @author     Chris Utz <chris@chrisutz.com>
 * @copyright  2007 Chris Utz <chris@chrisutz.com>
 * @license    http://www.opensource.org/licenses/bsd-license.php    New BSD License
 * @version    $Revision: 2 $
 */
class Ruth_Annotation_Parser
{
    /**
     * Extracts all substrings of the form @WORD WORD from a string.
     * 
     * @param string $text The text to extract annotations from
     * @return array An array containing the annotations
     * @throws Ruth_Annotation_Exception
     */
    public static function parse($text)
    {
        $numMatches = @preg_match_all('/^[ \t]*\*[ \t]*@(\w+)\s+([^\s]+).*$/m', $text, 
            $matches, PREG_SET_ORDER);

        if (FALSE === $numMatches) {
            throw new Ruth_Annotation_Exception("error parsing annotation text (preg_match_all failed)");
        }

        $annotations = array();

        foreach ($matches as $match) {
            $obj = new stdClass();
            $obj->name  = $match[1];
            $obj->value = $match[2];

            $annotations[$match[1]] = $obj;
        }

        return $annotations;
    }
}
 
// vim: sw=4:ts=4:sts=4:et
